home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIXPointer.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  4.3 KB  |  118 lines
  1. /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 2003
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Heikki Toivonen <heikki@netscape.com> (original author)
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #include "nsISupports.idl"
  40.  
  41. interface nsIDOMRange;
  42. interface nsIDOMDocument;
  43.  
  44. /**
  45.  * XXX A good XPointerResult would probably mimic XPathresult,
  46.  *     this range list is just the minimum that will be able to represent
  47.  *     all return values, although it would be more user friendly to return
  48.  *     nodes and node lists when they are possible.
  49.  */
  50. [scriptable, uuid(D3992637-F474-4b65-83ED-323FE69C60D2)]
  51. interface nsIXPointerResult : nsISupports
  52. {
  53.   nsIDOMRange                             item(in unsigned long index);
  54.   readonly attribute unsigned long        length;
  55. };
  56.  
  57.  
  58. /**
  59.  * Scheme context for nsIXPointerSchemeProcessor. The context consists of
  60.  * all the scheme/data pairs that precede the scheme/data that the
  61.  * nsIXPointerSchemeProcessor is currently evaluating.
  62.  */
  63. [uuid(781F4AA1-EBB3-4667-B1C2-2B35E94C4281)]
  64. interface nsIXPointerSchemeContext : nsISupports
  65. {
  66.   readonly attribute unsigned long count;
  67.   void getSchemeData(in unsigned long index,
  68.                      out DOMString scheme,
  69.                      out DOMString data);
  70. };
  71.  
  72. %{C++
  73. /**
  74.  * nsIXPointerSchemeProcessor implementations must be registered with the below
  75.  * progid, appended with the scheme name that the processor implements.
  76.  */
  77. #define NS_XPOINTER_SCHEME_PROCESSOR_BASE "@mozilla.org/xml/xpointer;1?scheme="
  78. %}
  79.  
  80. /**
  81.  * nsIXPointerSchemeProcessors will be called by the XPointer Processor that
  82.  * implements the XPointer Framework. This is done for each scheme the
  83.  * XPointer Processor finds, in left-to-right order.
  84.  */
  85. [uuid(093D3559-B56B-44d0-8764-C25815715080)]
  86. interface nsIXPointerSchemeProcessor : nsISupports
  87. {
  88.   /**
  89.    * Evaluate.
  90.    *
  91.    * @param aDocument The document in which to resolve the XPointer.
  92.    * @param aContext  The XPointer context in which to process aData.
  93.    * @param aData     The data in the scheme that needs to be resolved.
  94.    * @return          The result of the evaluation.
  95.    */
  96.   nsIXPointerResult evaluate(in nsIDOMDocument aDocument,
  97.                              in nsIXPointerSchemeContext aContext,
  98.                              in DOMString aData);
  99. };
  100.  
  101. /**
  102.  * nsIXPointerEvaluator resolves an XPointer expression
  103.  */
  104. [uuid(ADDD0FE5-8555-45b7-B763-97D5898CE268)]
  105. interface nsIXPointerEvaluator : nsISupports
  106. {
  107.   /**
  108.    * Evaluate an XPointer expression.
  109.    *
  110.    * @param aDocument   The document in which to evaluate.
  111.    * @param aExpression The XPointer expression string to evaluate.
  112.    * @return            The result.
  113.    */
  114.   nsIXPointerResult evaluate(in nsIDOMDocument aDocument,
  115.                              in DOMString aExpression);
  116.  
  117. };
  118.